This file covers the file formats for TA Mutation 
	Mutators
	Total Conversions
	AIs
	UFO Packs
	UFO Descriptions
Hopefully no problems will emerge and these file formats will be final

Best viewed with notepad, formatted for a fixed-width font and 8 column tabs


CONVENTIONS:

(these may seem obvious to some, but I just want make 
sure that I'm absolutely clear)

* text in angle brackets (eg <some text>) means that the text
	should be substituted by the actual value of the term, 
	not entered directly

* a dashed line(--------------) seperates the contents of a file
	from the surrounding text

* an ellipse (...) indicates an unknown number of items that fall 
	between the items immediately before and after it
	
* a capital N represents a number whose value may vary, it'll
	generally be seen in the context 1,2,...,N meaning a
	series of values ending in a selectable number. eg
		1,2,...,N where N is 7
	means
		1,2,3,4,5,6,7
	alternatively
		1,2,...,N where N is 0
	would mean that there are no values in this particular
	sequence (1 through 0, counting up)

* a capital X represents any element of a numbered sequence,
	for example, given the sequence
		file1,file2,...,fileN
	fileX is used to refer to the entire sequence 
		
______________________________________________________

		Mutators
______________________________________________________
Mutators are small-to-medium scale TA modifications
that override some aspects of a the active Total Conversion

All Mutator configuration files must be named like 
       }{<mutator name>.tam
and be located in the TA-Mutation folder

*NOTE* for a mutator that is released multiple times 
	the name should include a version number
	to prevent confusing TA:M if it is installed 
	while an older version is activated.

their internal format must be:
----------------------------
<Display Name>
<Description>
<TC compatibility codes>
<Number of support files>
<Blank line or end of file>
----------------------------


<Display Name> = the name of the Mutator as it appears in TA:M

<Description> = the description of the Mutator displayed in
	the description window. All occurances of ## are replaced 
	by a new line character (#### would be replaced by two 
	new line characters - in effect inserting a blank line)

<TC compatibility codes> - a list of the compatibility codes of all 
	the Total Conversions this Mutator is compatible with, 
	seperated by spaces (OTA referes to Original TA and TACC 
	refers to the Core Contingency, look at the .tc file of 
	actual TCs to find their codes).  If you attempt to activate 
	a Mutator that doesn't list the currently active TC then 
	a warning will be given

<number of support files> - the number of files (in addition to 
	the primary mutator file) required by this Mutator.  Most
	mutators will probably have this as 0 since they'll only need
	the primary mutator file
	
=================================
	MUTATOR EXAMPLE:
=================================

filename: }{Sample10.tam
----------------------
Sample Tam v1.0
A Sample Mutator File##This will appear on the next line
OTA TACC
1
----------------------
in TA:M the mutator will be listed as "Sample Tam v1.0", and the 
descriprion window will contain the text
	A Sample Mutator File
	This will appear on the next line

The mutator will give a wrning if the user isn't currently using
either the original TA or TA:Core Contingency as his/her active TC

When activated the mutator will cause the following files to be 
moved from the TA-Mutation folder into the TA folder:

}{Sample10.ccx    ------ the primary mutator file
}{Sample10(1).ccx ------ a support file

______________________________________________________

		Total Conversions
______________________________________________________
TCs are large-to-total modifications of TA. Examples 
might be UberHack or TA:Dune

All TC configuration files must be named like 
       ][<TC name>.tc
and be located in the TA-Mutation folder

*NOTE* for a TC that is released multiple times 
	the name should include a version number
	to prevent confusing TA:M if it is installed 
	while an older version is activated.
their internal format must be:
----------------------------
<Display Name>
<Description>
<TC code>
<source file 1>  <target file 1>
<source file 2>  <target file 2>
...
<source file N>  <target file N>
<Blank line or end of file>
----------------------------


<Display Name> = the name of the TC as it appears in TA:M

<Description> = the description of the TC displayed in the 
	description window.  All occurances of ## are replaced 
	by a newline character (#### would be replaced by two 
	newline characters - in effect inserting a blank line)

<TC code> - a code specific to this TC.  Mutators, AIs and units 
	will check the code from the currently active TC against 
	their list of compatible TC codes when they're activated.  
	If it's not found then the user will get a warning 
	suggesting that they disable it immediately.  If your mod 
	is basically minor, but you want it classified as a TC, 
	(eg Bugfix)	then you might wish to specify OTA or TACC as 
	the compatibility code so that all standard TA mutators, AIs 
	etc. will be treated as being compatible.  But only do this
	if your mod leaves the weapon and unit names unchanged.  You 
	can also specify "cross-compatibility" codes of other TCs here

<source file X>  <target file X> - a list of files to move from 
	the TA-Mutation folder to the TA folder (and what 
	to name them while in the TA folder) when this TC is
 	activated.  
	The source file names should all have the  form 
	][<TC name>(X).ufo and the target file names should be 
	identical, except in the special cases of totala1.hpi, 
	ccdata.hpi, and rev31.ufo.  If any of these three names
	is specified as the target name then the default TA 
	version of the file will be backed up with the extension 
	.### while the TC is in use and the specified file will
	replace it	
		*NOTE* TCs should only use filenames ending in .UFO, and must
	replace at least rev31.ufo if you expect to override any of the
	default TA files.
		*NOTE* if a .exe file with the same name as the TC is in 
	the TA directory when TA is launched from TA:M, then TA:M will
	use the new .exe instead.

===========================
	TC EXAMPLE:
===========================

filename: ][Uberhack20.tc
----------------------
Uberhack 2.0
BSR's wildly popular TA mod.##    Lots of changes here
UH UH20
][Uberhack20(1).ufo rev31.ufo
][Uberhack20(2).ufo ][Uberhack20(2).ufo
----------------------
in TA:M the TC will be listed as "Uberhack 2.0", and the 
description window will contain the text
	BSR's wildly popular TA overhaul.
	    Lots of changes here

When activated this TC file will cause the following files
to be moved from the TA-Mutation folder into the TA folder
and renamed:

FROM			TO
~~~~~~~~~		~~~~~~~~~
][Uberhack20(1).ufo	rev31.ufo  - (the original rev31.ufo will 
					be disabled)
][Uberhack20(2).ufo	][Uberhack20(1).ufo (just moved into the ta directory)

while this TC is active attempting to activate any Mutator, AI, or 
ufo that doesn't explicitly state that it's compatible with either 
UH or UH20 will cause a warning.

When TA is launched from TA:M the executable ][SampleTC26.exe will
be called instead of TotalA.exe

______________________________________________________

		AIs
______________________________________________________
AIs change the way computer opponents behave and may add
a few tweaked units to give them an advatage

All AI configuration files must be named like 
       ^^<AI name>.ai
and be located in the TA-Mutation folder

*NOTE* for a AI that is released multiple times 
	the name should include a version number
	to prevent confusing TA:M if it is installed 
	while an older version is activated.
their internal format must be:
----------------------------
<Display Name>
<Description>
<TC compatibility codes>
<target name 1>
<target name 2>
...
<target name N>
<Blank line or end of file>
----------------------------


<Display Name> = the name of the AI as it appears in TA:M

<Description> = the description of the AI displayed in the 
	description window.  All occurances of ## are replaced 
	by a newline character (#### would be replaced by two 
	newline characters - in effect inserting a blank line)

<TC compatibility codes> - a list of the compatibility codes of all 
	the Total Conversions this AI is compatible with, 
	seperated by spaces (OTA referes to Original TA and TACC 
	refers to the Core Contingency, look at the .tc file of 
	actual TCs to find their codes).  If you attempt to activate 
	an AI that doesn't list the currently active TC then 
	a warning will be given

<target file X> - a list of target names for the files and/or 
	folders which make up this AI.  The source names are 
	generated from the configuration file's name.
	*NOTE* all files should have a target name like ^^<AI name>(X).hpi
		(with an hpi extension)

===========================
	AI EXAMPLE:
===========================

filename : ^^bai4.ai
----------------------
BAI v4
*Cheating AI##*All AI units provided##BAI was an attempt to create an AI mod that could make up for some of the engine's shortcomings. It gives the AI the advantages of:##    (1) less expensive construction units,##    (2) factories with multiple exits,##    (3) enhanced resource units, and##    (4) improved profiles.##BAI can be *very* difficult on land maps. Try the Easy setting first, because Hard was designed to be a challenge for more than one player!## - BSR
TACC BF
AI
Documents
Gamedata
^^BAI4(4).hpi
----------------------
in TA:M the AI will be listed as "BAI v4", and the 
descriprion window will contain the text
	*Cheating AI
	*All AI units provided
	BAI was an attempt to create an AI mod that could make up for some of the engine's shortcomings. It gives the AI the advantages of:
	    (1) less expensive construction units,
	    (2) factories with multiple exits,
	    (3) enhanced resource units, and
	    (4) improved profiles.
	BAI can be *very* difficult on land maps. Try the Easy setting first, because Hard was designed to be a challenge for more than one player!
	 - BSR

The AIwill give a warning if the user isn't currently using
either the original TA or TA:Core Contingency as his/her active TC

When activated this TC file will cause the following files
to be moved from the TA-Mutation folder into the TA folder
and renamed:

FROM		TO
~~~~~~~~~	~~~~~~~~~
^^BAI4(1)	AI 
^^BAI4(2)	Documents
^^BAI4(3)	GAMEDATA
^^BAI4(4)	^^BAI4(4).hpi

______________________________________________________

		UNIT/UFO packs
______________________________________________________

These are simply lists of .ufo files that allow you to easily 
enable/disable groups of .ufos at one time.  They can still 
be managed individually, the packs are just for convenience.

All UFO pack configuration files must be named like
	<unit pack name>.pac
and be placed in the TA-Mutation\UfoManager folder

their internal format must be:
----------------------------
<Display Name>
<Description>
<ufo name 1>
<ufo name 2>
...
<ufo name N>
<Blank line or end of file>
----------------------------


<Display Name> = the name of the pack as it appears in TA:M

<Description> = the description of the pack displayed in the 
	description window. All occurances of ## are replaced 
	by a newline character (#### would be replaced by two 
	newline characters - in effect inserting a blank line)


<ufo name X> - a list of the units this pack enables/disables 
	(minus the .ufo extension).  Unlike all the other 
	configuration files if a specified file doesn't exist 
	then it's simply ignored.

================================
	UFO PACK EXAMPLE:
================================
(this sample will actually work if you create it, 
assuming I got the names right of course)

filename : CDunits.pac
----------------------
Cavedog's Units
Manages all of Cavedog's post-TA v3.1 units##     Arm Scarab##     Arm Flea##     Core Hedgehog##     Core Immolator
ascarab
aflea
chedge
cimlator
----------------------
in TA:M the AI will be listed as "CaveDog's Units", and the 
descriprion window will contain the text
	Manages all of Cavedog's post-TAv3.1 units
	     Arm Scarab
	     Arm Flea
	     Core Hedgehog
	     Core Immolator

If you haven't created text files for the individual units specifying 
TC compatibility codes then this will issue warnings if you're not using 
the Original TA "Total Conversion"

When activated this TC file will cause the following files
to be moved from the TA-Mutation\UfoManager folder into 
the TA folder (assuming they're not missing or already active)

ascarab.ufo
aflea.ufo
chedge.ufo
cImlator.ufo

When deactivated it will move the same files back into the 
TA-Mutation\UfoManager folder.
______________________________________________________

		UFO Descriptions
______________________________________________________
the most basic of the TA:M configuration files, simply provides a 
descriptionof the ufo, and optionaly it's TC compatibility codes 

all UFO description files must have the name
	<ufo name>.txt
and the format
-------------------
@<TC compatibility codes>
<description>
<more description>
<more description>
...
<even more description>
-------------------

<TC compatibility codes> - if the first line starts with the @ 
	character then the rest of that line is assumed to be a list
	of compatibility codes of all the Total Conversions this unit
	 is compatible with, seperated by spaces (OTA referes to 
	Original TA and TACC refers to the Core Contingency, look at 
	the .tc file of actual TCs to find their codes).  If you 
	attempt to activate a unit that doesn't list the currently 
	active TC then a warning will be given.
	*NOTE* if there is no unit description file, or the first line 
		in the file doesn't start with an @ character, then the 
		compatibility codes are assumed to be OTA and TACC

<description...> - a description of the unit.  Unlike in other formats 
	this is taken completely unmodifed.  Roughly the first 1k of the 
	file is displayed as the description with newlines preserved, 
	allowing non-TA:M compatible text files to be used as-is
===========================================
	UFO DESCRIPTION EXAMPLE
===========================================
filename: aflea.txt

--------------------------
@TACC
A kbot capable of fast scouting and light unit harassment 
Costs:
    Energy: 27,364
    Metal:  3,823
    Build Time: 15,246
---------------------------

specifies that the unit will be considered compatible with TA:CC only (a
	warning will be given when enabled with any other TC, including
	original TA)
when selected the unit description will read
	A kbot capable of fast scouting and light unit harassment 
	Costs:
	    Energy: 27,364
	    Metal:  3,823
	    Build Time: 15,246

*NOTE* all values here are random guesses, don't bother writing to tell me I 
	got them wrong.  And yes I know that the Flea is atually OTA compatible.
